Łączenie obiektów z usługami sieci Web REST.

Pierwszym krokiem jest dodanie zachowania usługi sieci Web REST do obiektu, który ma zostać użyty do integracji z punktem końcowym.

Aby dodać zachowanie usługi sieci Web REST do obiektu:

1. Otwórz w Projektancie obiektów obiekt, który ma być używany z usługą sieci Web REST.
2. Wybierz obiekt u góry drzewa Atrybuty, a następnie w siatce Właściwości kliknij przycisk obok właściwości Zachowania.
   Zostanie wyświetlone okno dialogowe Wybór zachowania.
3. Z listy Dostępne elementy wybierz pozycję Usługa sieci Web REST, a następnie kliknij .
   Pozycja Usługa sieci Web REST zostanie przeniesiona na listę Wybrane elementy.
4. Kliknij przycisk OK, aby zapisać zmiany.
   Okno dialogowe Wybór zachowania zostanie zamknięte, a na siatce Właściwości pojawi się nowy element, tj. Usługi sieci Web REST.
   Ponadto w obiekcie zostaną utworzone cztery nowe atrybuty: Treść żądania utworzenia usługi REST, Status utworzenia usługi REST, URI żądania utworzenia usługi REST oraz relacja o nazwie Szablon treści żądania utworzenia usługi REST, która jest relacją do nowego obiektu listy odwołań o nazwie ObjectBody. (Obiekt to nazwa obiektu, do którego dodano zachowanie).

Należy utworzyć okna dla wszystkich nowo utworzonych obiektów.

5. Na siatce Właściwości kliknij obok pozycji Usługi sieci Web REST.
   Zostanie wyświetlone okno dialogowe Usługa sieci Web REST.
6. Na karcie Żądanie w polu URI punktu końcowego wpisz identyfikator URI punktu końcowego, którego chcesz użyć.

W polu URI punktu końcowego można wprowadzić symbole zastępcze. Są one najczęściej stosowane w przypadku opcji PATCH.

7. Wybierz odpowiednio POST, PATCH lub DELETE.
   Funkcja Post jest zwykle używana do tworzenia elementów, natomiast funkcja Patch służy do aktualizacji istniejących elementów. Aby utworzyć element za pomocą usługi sieci Web REST, a następnie zaktualizować ten element za pomocą tej usługi, należy utworzyć dwa obiekty: jeden w celu utworzenia elementu za pomocą funkcji Post, a drugi w celu aktualizacji elementu za pomocą funkcji Patch.
8. Z listy rozwijanej Typ treści wybierz typ treści, którą wysyłasz.
9. Z listy Typ uwierzytelniania wybierz typ wymaganego uwierzytelniania: Brak, Podstawowe, Klucz API (nagłówek), OAuth2 (poświadczenia klienta) lub OAuth2 (hasło) wraz z dodatkowymi parametrami.
10. Kliknij przycisk OK.

W pewnych sytuacjach może być konieczne tymczasowe wyłączenie zachowania REST. Można to zrobić w odniesieniu do konkretnego obiektu, usuwając zaznaczenie pola wyboru Włącz w oknie dialogowym Usługi sieci Web REST.

Aby wykonać dalsze działania względem rekordu utworzonego za pomocą usługi sieci Web REST, należy określić ścieżkę do unikatowego identyfikatora zwróconego przez aplikację zewnętrzną oraz lokalizację w systemie Service Desk, w której mają być przechowywane te informacje.

Aby przechowywać unikatowe identyfikatory:

1. Na karcie Mapowanie odpowiedzi okna dialogowego Wybór zachowania, w polu Źródło, wpisz ścieżkę do unikatowego identyfikatora zwracanego przez aplikację zewnętrzną.
   Do identyfikacji elementów w źródłowym ładunku danych można użyć zapisu kropkowego. Wpisz *, aby użyć całej odpowiedzi.
2. W polu Cel wpisz atrybut Service Desk typu string, w którym chcesz zapisać zwróconą wartość.
   Będzie mieć postać {_Request/Field}.
3. Z listy rozwijanej Zaakceptuj wybierz typ treści, którą odbierasz.
   W przypadku wyboru formatu XML wskaż Przestrzenie nazw XML, oddzielając nazwy poszczególnych przestrzeni spacjami. Przykład: xmlns:h="http://www.w3.org/TR/html4/" xmlns:r="http://www.example.com/example/"
4. Kliknij przycisk OK.

Po skonfigurowaniu połączenia między obiektem systemu Service Desk a punktem końcowym można określić zawartość wysyłanego ładunku. Ładunek musi być typu JSON lub XML. Niektóre punkty końcowe akceptują wiele różnych ładunków. Na przykład Ivanti Automation udostępnia pojedynczy punkt końcowy, który akceptuje ładunki dla wielu elementów Runbook z żądanym elementem określonym w zawartości ładunku.

Z tego powodu podczas dodawania zachowania usługi sieci Web REST tworzona jest relacja szablonu treści żądania utworzenia usługi Rest do obiektu listy odwołań ObjectBody. Umożliwia to utworzenie listy odwołań (więcej szczegółów w temacie Tworzenie nowych list odwołań odwołań) do przechowywania różnych zawartości ładunków, a następnie, w ramach procedury, udostępnienie mechanizmu wyboru odpowiedniej instancji listy odwołań (na przykład poprzez zastosowanie typu wartości w działaniu automatycznym; więcej szczegółów w temacie Określanie wartości dynamicznych na potrzeby działań automatycznych). Dodając do listy ObjectBody symbole zastępcze podobne do tych, które są używane przy określaniu wartości dynamicznych w działaniach automatycznych, można umieścić w ładunku wartości pobierane z instancji obiektów Service Desk. Jeśli używasz symboli zastępczych, dodaj je w kontekście obiektu RESTful.

Każdy obiekt z zachowaniem REST musi mieć co najmniej jedną pozycję na odnośnej liście odwołań, która zawiera odpowiednią zawartość ładunku.

Aby ułatwić sobie zaprojektowanie takiego ładunku, można nawiązać połączenie z punktem końcowym za pomocą narzędzia Swagger.